api/order/fileAttachment/post/{orderID} (Post)

Post	api/order/fileAttachment/post/{orderID}

In This Topic

Resource Path: /sites/{company-id}/api/order/fileAttachment/post/{orderID}

Uri: https://secure.ontime360.com/sites/{company-id}/api/order/fileAttachment/post/{orderID}

Description

Attaches a FileAttachment to an existing Order.

Parameters

Name	Description	Data Type
orderID	The unique identifier of the Order as a Guid.	string

Request

The request body is of type FileAttachment.

A comprehensive FileAttachment object containing the attachment's image data.

FileAttachment

Represents a comprehensive FileAttachment record within the OnTime API.

ID : string

The unique identifier for this FileAttachment record.

FileName : string

The exact file name of the FileAttachment.

Contents : string

An array of unsigned bytes representing the raw data for this FileAttachment.

Timestamp : string

The date and time that that this FileAttachment was created.

201 Response

The response body is of type object.

Returns the created FileAttachment object.

Fault Responses

Fault	Description
400	Indicates that the newly created unique identifier references an existing FileAttachment record. Request must be repeated in this case.
401	Authorization key is invalid or no longer exists.
403	Authorization key does not have permission to perform this action, or does not have permission to access the requested data.